home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / rahdr10.zip / RAHDR.DOC next >
Text File  |  1991-08-04  |  16KB  |  531 lines
  1.                              ┌────────┐ ┌────────┐
  2.                              │  ┌──┐  │ │  ┌──┐  │
  3.                              │  └──┘ ┌┘ │  └──┘  │
  4.                              │  ┌──┐ └┐ │  ┌──┐  │
  5.                              │  │  │  │ │  │  │  │
  6.                              └──┘  └──┘ └──┘  └──┘
  7.  
  8.         ┌──┐  ┌──┐ ┌───────┐ ┌────────┐ ┌──────┐   ┌───────┐ ┌────────┐
  9.         │  │  │  │ │ ┌─────┘ │  ┌──┐  │ │  ┌─┐ └─┐ │ ┌─────┘ │  ┌──┐  │
  10.         │  └──┘  │ │ └────┐  │  └──┘  │ │  │ └─┐ │ │ └────┐  │  └──┘ ┌┘
  11.         │  ┌──┐  │ │ ┌────┘  │  ┌──┐  │ │  │ ┌─┘ │ │ ┌────┘  │  ┌──┐ └┐
  12.         │  │  │  │ │ └─────┐ │  │  │  │ │  └─┘ ┌─┘ │ └─────┐ │  │  │  │
  13.         └──┘  └──┘ └───────┘ └──┘  └──┘ └──────┘   └───────┘ └──┘  └──┘
  14.  
  15.                                  Version 1.0
  16.  
  17.                      A RemoteAccess utility for file area
  18.                      headers, bulletins, and allfiles list.
  19.  
  20.  
  21.                              (C) Copyright 1991
  22.  
  23. ╓─────────────────────────────────────────────────────────────────────────────╖
  24. ║ ░░░░░░░ RA HEADER v1.0 ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  25. ╙─────────────────────────────────────────────────────────────────────────────╜
  26.  
  27.                      Documentation and programming by Dan Roseen
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67. ╓─────────────────────────────────────────────────────────────────────────────╖
  68. ║ ░░░░░░░ TABLE OF CONTENTS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  69. ╙─────────────────────────────────────────────────────────────────────────────╜
  70.  
  71. Disclaimer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  3
  72.  
  73. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  3
  74.  
  75. Files  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  3
  76.  
  77. Options and Features . . . . . . . . . . . . . . . . . . . . . . . . . .  4
  78.  
  79. Configuring RA Header  . . . . . . . . . . . . . . . . . . . . . . . . .  5
  80.  
  81. RA Header Operation  . . . . . . . . . . . . . . . . . . . . . . . . . .  6
  82.  
  83. RAHDR.ERR  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  6
  84.  
  85. Registration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  7
  86.  
  87. Support and Distribution . . . . . . . . . . . . . . . . . . . . . . . .  8
  88.  
  89. Thank You To:  . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  9
  90.  
  91. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . .  9
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.                                      Page 2
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128. ╓─────────────────────────────────────────────────────────────────────────────╖
  129. ║ ░░░░░░░ DISCLAIMER   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  130. ╙─────────────────────────────────────────────────────────────────────────────╜
  131.  
  132. RA Header and it's utilities are provided AS IS.  I give no warranty of any
  133. kind, nor am I responsible for the results of use or misuse of the afore-
  134. mentioned program and utilities.
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141. ╓─────────────────────────────────────────────────────────────────────────────╖
  142. ║ ░░░░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  143. ╙─────────────────────────────────────────────────────────────────────────────╜
  144.  
  145. RA Header is a utility developed for RemoteAccess that will create/modify your
  146. BBS file area listings so they will include a summary of the area's files.  The
  147. headers created are sysop configurable and act as a guide and summary to your
  148. users.
  149.  
  150. RA Header is very flexible and has options for creating a Masterfile
  151. (allfiles) list and File Area Summary bulletins.
  152.  
  153. You will find RA Header very sysop friendly.  A setup program has been included
  154. that will configure RA Header and show you it's many features.  The setup
  155. program has on-screen help and examples to guide you.
  156.  
  157. RA Header was written using Borland's Turbo C v2.0.  It requires an IBM PC, AT,
  158. or 100% compatible computer.  It has been tested with RemoteAccess v1.01 and
  159. MS-DOS v3.3.  This program is untested with lower versions of DOS.
  160.  
  161.  
  162.  
  163. ╓─────────────────────────────────────────────────────────────────────────────╖
  164. ║ ░░░░░░░ FILES        ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  165. ╙─────────────────────────────────────────────────────────────────────────────╜
  166.  
  167. RAHDR.DOC . . . . . . . . . . . . .  This documentation text file
  168. RAHDR.EXE . . . . . . . . . . . . .  RA Header program
  169. RAHDR.REG . . . . . . . . . . . . .  RA Header registration form
  170. RAHDR.TOP . . . . . . . . . . . . .  Example file for top of allfiles list
  171. RAHDRCFG.EXE  . . . . . . . . . . .  Setup utility for RA Header
  172.  
  173.  
  174.  
  175.  
  176.                                      Page 3
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186. ╓─────────────────────────────────────────────────────────────────────────────╖
  187. ║ ░░░░░░░ OPTIONS AND FEATURES ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  188. ╙─────────────────────────────────────────────────────────────────────────────╜
  189.  
  190.   ■ Can reside in any directory.
  191.   ■ Specific file areas may be excluded from RA Header.
  192.   ■ Creates backups of FILES.BBS.
  193.   ■ Supports up to 256 characters per text line in FILES.BBS.
  194.   ■ Header format may be hatched, ASCII, or Extended ASCII.
  195.   ■ A file areas summary bulletin can be created when RA Header is run.
  196.   ■ Bulletin format may be hatched, ASCII, or Extended ASCII.
  197.   ■ A Masterfile (allfiles) list can be created when RA Header is run.
  198.   ■ A file (example: your advertisement) may be automatically attached to the
  199.     top of your Masterfile list.
  200.   ■ Your RA Header bulletin will be automatically attached to the end of your
  201.     Masterfile list.
  202.   ■ Sysop friendly RA Header setup utility with help and examples.
  203.   ■ RA Header setup utility is DESQview-aware.
  204.   ■ Extensive error checking reports warnings and errors (if any) on-screen
  205.     and to an error log.
  206.   ■ Reads RemoteAccess configuration files to retrieve necessary information.
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.                                      Page 4
  238.  
  239.  
  240.  
  241.  
  242. ╓─────────────────────────────────────────────────────────────────────────────╖
  243. ║ ░░░░░░░ CONFIGURING RA HEADER ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  244. ╙─────────────────────────────────────────────────────────────────────────────╜
  245.  
  246. RAHDRCFG.EXE is included to configure RA Header to your liking.  You will see
  247. online help and examples for each option.
  248.  
  249. A configuration file (RAHDR.CFG) is created or modified in the current
  250. directory when RAHDRCFG is run.  You can use RAHDRCFG.EXE or a text editor to
  251. modify RAHDR.CFG.  For those who wish to use a text editor to edit the
  252. configuration file, the format of RAHDR.CFG must be in the following format
  253. (I suggest you run RAHDRCFG.EXE at least once to try it.  It will create a
  254. RAHDR.CFG file you can use for a template if you still want to use an editor):
  255.  
  256. Line 1: Your RA Header registration number.
  257. Line 2: Your RA directory (include drive letter).
  258. Line 3: File areas you wish to exclude.  (Example: 2,5,8)
  259.         Note: You can exclude more file areas than RAHDRCFG.EXE permits
  260.         by using a text editor (I'm not trying to encourage using an editor)
  261. Line 4: Header style   (1 = hatched, 2 = ASCII, 3 = extended ASCII)
  262. Line 5: Bulletin style (1 = hatched, 2 = ASCII, 3 = extended ASCII)
  263. Line 6: ASCII bulletin (include drive letter).
  264.         Note: This file will also automatically get appended to the bottom of
  265.         your masterfiles list.  Leave blank if you don't want this bulletin.
  266. Line 7: ANSI bulletin  (include drive letter)
  267.         Note: Leave blank if you don't want this bulletin.
  268. Line 8: Masterfiles (allfiles) list (include drive letter).
  269. Line 9: File for top of masterfiles list.
  270.         Note: This file will automatically be attached to the top of your
  271.         masterfiles list.  Leave blank if you don't want to use this file.
  272.  
  273. Example:
  274. ────────
  275. 0
  276. C:\RA
  277.  
  278. 3
  279. 3
  280. C:\RA\RAHDR.ASC
  281. C:\RA\RAHDR.ANS
  282. C:\RA\RAHDR.ALL
  283. C:\RA\RAHDR.TOP
  284.  
  285.  
  286. RAHDR.CFG must be in the same directory that RA Header is run from unless it is
  287. supplied as an argument to RA Header.
  288.  
  289. Examples:
  290. ─────────
  291.  
  292. Loading and running RA Header specifying an RAHDR.CFG path:
  293. C:\RA\RAHDR>rahdr c:\misc\rahdr.cfg
  294.  
  295. Loading and running RA Header without specifying an RAHDR.CFG path:
  296. C:\RA\RAHDR>rahdr
  297.  
  298.                                      Page 5
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306. ╓─────────────────────────────────────────────────────────────────────────────╖
  307. ║ ░░░░░░░ RA HEADER OPERATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  308. ╙─────────────────────────────────────────────────────────────────────────────╜
  309.  
  310. RA Header will read your CONFIG.RA and FILES.RA files to retrieve the
  311. following information:
  312.                          ■ Sysop name (when RA Header is registered)
  313.                          ■ BBS name
  314.                          ■ Missing files string
  315.                          ■ Number of file areas
  316.                          ■ File area names
  317.                          ■ Minimum security for each file area.
  318.                          ■ File area locations
  319.  
  320. It will then retrieve the configuration options you selected when running
  321. RAHDRCFG.EXE and proceed to the first file area to build the FILES.BBS file
  322. (makes a backup FILES.BAK first).  If a file area was excluded using RAHDRCFG,
  323. RA Header will simply skip this file area and proceed to the next.
  324.  
  325. If a file is missing, it will be counted as a file in that area, but with
  326. 0 kilobytes in length.  If a Masterfiles list is being created, the missing
  327. file will use the missing file string you have chosen while running
  328. RACONFIG.EXE.
  329.  
  330. Bulletins and Masterfiles list (if selected with RAHDRCFG) will be created
  331. at the same time the headers are being created/updated for your different
  332. file areas.
  333.  
  334.  
  335.  
  336. ╓─────────────────────────────────────────────────────────────────────────────╖
  337. ║ ░░░░░░░ RAHDR.ERR    ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  338. ╙─────────────────────────────────────────────────────────────────────────────╜
  339.  
  340. RA Header makes extensive error/warning checks during it's operation.  RA
  341. Header will create or append to a file called RAHDR.ERR whenever it encounters
  342. an error or warning.  RAHDR.ERR will be written to the current working
  343. directory.  You may delete this file when you don't want it anymore.
  344.  
  345. Errors are problems that are critical to running RA Header (example: RAHDR.CFG
  346. not found).  RA Header will exit when it encounters an error condition.
  347.  
  348. Warnings are problems that will affect the performance of RA Header (example:
  349. insufficient disk space for FILES.BAK).  RA Header will not continue with
  350. the operation that produced the warning but will move on to the next task.
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.                                      Page 6
  359.  
  360.  
  361.  
  362.  
  363.  
  364. ╓─────────────────────────────────────────────────────────────────────────────╖
  365. ║ ░░░░░░░ REGISTRATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  366. ╙─────────────────────────────────────────────────────────────────────────────╜
  367.  
  368. Please support shareware!
  369.  
  370.  
  371. You are granted permission to evaluate RA Header for a period of 30 days.
  372. After this evaluation period a $10.00 (US funds) registration fee is required.
  373. If you do not plan to register, then remove RA Header and it's associated
  374. files from use.
  375.  
  376. Upon receipt of your registration fee, a registration number will be sent to
  377. you.  Use this registration number to register your copy of RA Header by using
  378. RAHDRCFG.EXE.
  379.  
  380. RA Header, as an unregistered copy, is not crippled in any way.  Registered
  381. owners will receive their registration number that will do the following:
  382.  
  383.   ■ Remove "UNREGISTERED" from the file area headers.
  384.   ■ Replace "Registered to:  UNREGISTERED" with
  385.     "Registered to:  'your_sysop_name'" in the bulletins.
  386.  
  387.  
  388. Your registration is valid for future versions of RA Header.
  389. In future versions, I hope to:
  390.                               ■ Optionally include the file area's most
  391.                                 downloaded file in the header.
  392.                               ■ Optionally include the file area's newest
  393.                                 file in the header.
  394.                               ■ Provide an option to have a fully
  395.                                 sysop customized header style.  Possibly
  396.                                 an editor built into RAHDRCFG.EXE for this.
  397.                               ■ Increase RA Header's speed and efficiency.
  398.                               ■ Flag files that are less than X days old in
  399.                                 allfiles list.
  400.                               ■ Incorporate some of your good suggestions!
  401.  
  402. Please use the file RAHDR.REG to send in your registration information.  Send
  403. your RAHDR.REG information, plus a $10 check or money order (US funds) to:
  404.  
  405.                               Dan Roseen
  406.                               P.O. Box 5695
  407.                               Kent, WA  98064-5695
  408.  
  409. Please make checks or money order payable to Dan Roseen.
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.                                      Page 7
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426. ╓─────────────────────────────────────────────────────────────────────────────╖
  427. ║ ░░░░░░░ SUPPORT AND DISTRIBUTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  428. ╙─────────────────────────────────────────────────────────────────────────────╜
  429.  
  430. Updates and/or new releases of RA Header can be downloaded from my BBS,
  431. The Night Owl (shown below).  You will have to fill out a newuser
  432. questionnaire.  Once you have done this you will have enough access to
  433. download RA Header without complete user verification.  You may leave your
  434. comments, questions, and suggestions to Dan Roseen if I am not available for
  435. chat.
  436.  
  437. If you are experiencing problems, call The Night Owl BBS or write me and
  438. include the following information:
  439.  
  440.                    ■ As much detail as possible explaining the problem.
  441.                    ■ Your full registration number.
  442.                    ■ Your RAHDR.CFG and RAHDR.ERR (if this exists) files.
  443.                    ■ Your AUTOEXEC.BAT and CONFIG.SYS files.
  444.  
  445.  
  446. You may contact the following systems:
  447.  
  448. Support and Distribution
  449. ────────────────────────
  450. Sysop:       Dan Roseen
  451. BBS:         The Night Owl     - A RemoteAccess system.
  452. Number:      (206)631-4949       23 Hrs.        Kent, WA - USA
  453.              USRobotics HST DS
  454. Comment:     For downloading latest version:  Do a [T]ext Search for "RAHDR".
  455.  
  456.  
  457. Distribution ONLY
  458. ─────────────────
  459. Sysop:       Jim Radford
  460. BBS:         Northwest PC Link - A PCBoard system.
  461. Fidonet:     1:343/600
  462. Main access: (206)852-4364       23 Hrs.        Kent, WA - USA
  463.              1200/2400 MNP5
  464. Alt. access: (206)854-5646       23 Hrs.
  465.              USRobotics HST DS
  466. Comment:     For downloading latest version:  Do a [Z]ippy directory scan
  467.                                               for "RAHDR".
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.                                      Page 8
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492. ╓─────────────────────────────────────────────────────────────────────────────╖
  493. ║ ░░░░░░░ THANK YOU TO: ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  494. ╙─────────────────────────────────────────────────────────────────────────────╜
  495.  
  496. Denise Roseen, my wife, for her encouragement and for helping me set aside
  497. time to work on this project.
  498.  
  499. Jim Radford, a long-time friend, for his suggestion to make RA Header a
  500. versatile program that others can use.  Also, for suggesting I build a
  501. configuration setup program to go with it.
  502.  
  503. Richard Merit, for his willingness to beta test RA Header v1.0 and for his
  504. comments and suggestions.
  505.  
  506. Scott Parks, sysop of The Helix BBS, for his willingness to beta test RA
  507. Header v1.0 and for his comments and suggestions.
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514. ╓─────────────────────────────────────────────────────────────────────────────╖
  515. ║ ░░░░░░░ ACKNOWLEDGEMENTS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ║
  516. ╙─────────────────────────────────────────────────────────────────────────────╜
  517.  
  518. Turbo C v2.0 is a registered trademark of Borland International, Inc.
  519. RemoteAccess is a product of Continental Software.
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.                                      Page 9
  531.